home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 22 / AACD 22.iso / CDTools / VersionCopy / VersionCopy.readme < prev    next >
Text File  |  2000-08-03  |  3KB  |  81 lines
  1. Short: Copy files with version check
  2. Author: Chris <chris@worldfoundry.demon.co.uk>
  3. Type: util/cli
  4. Version: 2.0
  5. License: GNU GPL
  6.  
  7.  
  8. TEMPLATE
  9.  
  10.     VersionCopy FROM/A,TO/A,QUIET/S,BUF=BUFFER/K/N,CLONE/S,DATE/S,COM/S,NOPRO/S,IGNORENAME/S
  11.  
  12.  
  13. FUNCTION
  14.  
  15.     VersionCopy is a cut-down "Copy" command which is aware of the version information
  16. within the file being copied. Before copying the source file it checks whether the
  17. destination already exists and, if it does, the version numbers of the source and
  18. destination are compared. The source is only copied over the destination if the
  19. source version or revision is greater than that of the destination. Unlike Copy,
  20. wildcards and directory copy are not supported - indeed these facilities would be
  21. somewhat meaningless for the applications this command is intended.
  22.  
  23.  
  24. ARGUMENTS
  25.  
  26.     FROM/A          The name of the source file. Note that wildcards and directories
  27.                     are not supported.
  28.  
  29.     TO/A            The name of the destination. If this is a directory or volume name
  30.                     then the filename part of the FROM is used (ie:
  31.  
  32.                     VersionCopy foo:bar/fred ram:
  33.  
  34.                     will result in ram:fred being written if required)
  35.  
  36.     QUIET/S         If specified, any error or warning messages are suppressed.
  37.  
  38.     BUFFER/K/N      This option allows you to change the number of 512 byte buffers
  39.                     used during the copying process. By default 200 buffers (100k)
  40.                     are allocated, small files may be copied more efficiently with
  41.                     fewer buffers than this.
  42.  
  43.     CLONE/S         If set, VersionCopy will copy the source date, comment and
  44.                     protection bits to the destination.
  45.  
  46.     DATE/S          This instructs VersionCopy to set the destination date to the
  47.                     same value as the source.
  48.  
  49.     COM/S           When this is set VersionCopy will copy the source file comment
  50.                     to the destination.
  51.  
  52.     NOPRO/S         By default, VersionCopy retains the protection bits of the
  53.                     source when it does a copy, you can suppress this action by
  54.                     setting the NOPRO argument. (Note that this is ignored if CLONE
  55.                     is set!)
  56.  
  57.     IGNORENAME/S    The version checking routine compares the version names given
  58.                     in the source and destination files. If they are different then
  59.                     VersionCopy assumes that you're trying to copy one version of
  60.                     a file over a completely unrelated file and the copy fails.
  61.                     Unfortunately this will lead to false error reports if the
  62.                     author of the file or library changes the name in the version
  63.                     string between versions - by setting IGNORENAME you can
  64.                     deactivate the name checking.
  65.  
  66. RESULT
  67.  
  68.     The following codes can be generated by VersionCopy in addition to those
  69.     generated by file commands in normal use (202 - object in use etc..):
  70.  
  71.     0 (OK)                  VersionCopy did nothing - the destination is up to
  72.                             date.
  73.  
  74.     5 (WARN)                VersionCopy copied the file
  75.  
  76.     103 (NO_FREE_STORE)     A memory operation failed and VersionCopy aborted
  77.                             with no action
  78.  
  79.     212 (OBJECT_WRONG_TYPE) Either the source is a directory or it doesn't
  80.                             contain a version string.
  81.